Skip to content

Restore and clarify deployment help links and coverage#233

Merged
stiwicourage merged 4 commits into
developfrom
feature/215-refactordeploy-novapackage-align-with-terminal-ux-design-principles
May 24, 2026
Merged

Restore and clarify deployment help links and coverage#233
stiwicourage merged 4 commits into
developfrom
feature/215-refactordeploy-novapackage-align-with-terminal-ux-design-principles

Conversation

@stiwicourage

Copy link
Copy Markdown
Owner

Summary

  • Clarified Get-NovaProjectInfo failure handling so invalid -Path values now stop with actionable Nova-style recovery guidance instead of generic path-resolution errors.
  • Added targeted tests for the missing-path, file-path, and missing-project.json cases, and updated the cmdlet help plus release-facing notes to match the final behavior.
  • Needed to align issue #216 with terminal UX guidance while preserving the existing success-path output contract. Closes refactor(Get-NovaProjectInfo): align with terminal-ux-design principles #216.

Affected area

  • nova CLI or command routing
  • Public PowerShell cmdlet behavior
  • Scaffolding or project.json handling
  • Build, test, analyzer, coverage, or CI helper flow
  • Package, raw upload, or package metadata workflow
  • Publish, release, or GitHub Actions automation
  • Self-update or notification preference behavior
  • Contributor documentation (README.md, CONTRIBUTING.md, repository workflow docs)
  • End-user docs (docs/*.html)
  • Command help (docs/NovaModuleTools/en-US/*.md)
  • src/resources/example/
  • Dependency or manifest changes (project.json, workflow dependencies, release tooling)
  • Security-sensitive change
  • Documentation-only change
  • Agentic Copilot Workflow + scaffold mirror + scaffold-sync guardrail test.
  • Other

Review guidance

  • Start with src/private/shared/GetNovaProjectInfoContext.ps1, where the staged change splits the failure path into three explicit cases: missing path, non-directory path, and missing project.json.
  • Then review tests/private/shared/GetNovaProjectInfoContext.Tests.ps1 for the new expectations and docs/NovaModuleTools/en-US/Get-NovaProjectInfo.md for the user-facing help update.
  • This is a low-risk terminal-UX refinement only: no versioning, publish-flow, or success-path output changes, and the same behavior applies to the current 3.0.2-preview line and the next stable releasebecause the staged change only improves validation/error guidance.

Validation

  • Invoke-NovaBuild
  • Test-NovaBuild
  • ./scripts/build/Invoke-ScriptAnalyzerCI.ps1
  • ./scripts/build/ci/Invoke-NovaModuleToolsCI.ps1
  • Targeted Nova workflow validated (% nova build, % nova test, % nova merge, % nova deploy, % nova publish, % nova release, % nova update, % nova notification, or % nova init as relevant)
  • Docs/example only; executable validation not needed

Validation notes:

pwsh -NoLogo -NoProfile -Command "Invoke-NovaBuild; Import-Module ./dist/NovaModuleTools/NovaModuleTools.psd1 -Force; Test-MarkdownCommandHelp -Path ./docs/NovaModuleTools/en-US/Get-NovaProjectInfo.md -DetailView"
pwsh -NoLogo -NoProfile -File ./run.ps1
CodeScene pre-commit safeguard: passed

No CI workflow, package, publish, or release automation path changed in the staged diff.

Documentation and release follow-up

  • README.md reviewed and updated if contributor workflow, architecture, CI, release, or automation changed
  • CONTRIBUTING.md reviewed and updated if contribution expectations or review guidance changed
  • CHANGELOG.md reviewed and updated if the change matters to users, maintainers, or contributors
  • RELEASE_NOTE.md reviewed and updated if the change affects public cmdlet usage, CLI usage, configuration semantics, or migration expectations
  • docs/NovaModuleTools/en-US/ help updated if a public command or CLI behavior changed
  • docs/*.html updated if end-user workflows or examples changed
  • src/resources/example/ reviewed and updated if the real-world project layout, package model, or upload workflow changed
  • No documentation, changelog, release-note, or example updates were needed

Maintainability, compatibility, and risk

  • Code Health / maintainability impact considered
  • No breaking change
  • Breaking change
  • Security-sensitive change
  • CI, workflow, or release-pipeline impact
  • Dependency-review impact

Risk, rollout, or rollback notes:

Low risk. The staged change is isolated to Get-NovaProjectInfo path validation and user-facing help/release text.

Compatibility impact:
- No parameter, output-shape, versioning, or publish-flow change.
- Existing successful calls keep the same object/string results.

Rollback:
- Revert the GetNovaProjectInfoContext helper change and its matching test/help/changelog entries.

@github-actions

Copy link
Copy Markdown
Contributor

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

@codescene-delta-analysis codescene-delta-analysis Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gates Passed
6 Quality Gates Passed

See analysis details in CodeScene

Quality Gate Profile: Pay Down Tech Debt
Install CodeScene MCP: safeguard and uplift AI-generated code. Catch issues early with our IDE extension and CLI tool.

@codescene-delta-analysis codescene-delta-analysis Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Coverage Gates Passed
Overall Coverage: 99.4% (required = 95%)
New & Changed Code Coverage: 100% (required = 99%)

Review details by gate
  • Overall Coverage

    • Pass/Fail Reason:
      The overall coverage gate was checked for all code and meets the goal: 99.4% covered >= threshold = 95%
    • Action:
      You have 292 files with a sum of 3286 covered and 19 uncovered lines of code.
  • New & Changed Code Coverage

    • Pass/Fail Reason:
      New or changed code meets coverage goal: 100% covered >= threshold = 99%
    • Action:
      You modified 1 files, and covered 9 added/modified lines of code.

@stiwicourage
stiwicourage merged commit f746ead into develop May 24, 2026
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

refactor(Get-NovaProjectInfo): align with terminal-ux-design principles

1 participant